Skip to content

Conversation

Copy link

Copilot AI commented Jun 29, 2025

This PR applies the changes from opentelemetry-java-instrumentation#14155 to enable local execution of lychee link checking with Docker.

Changes Made

New Files

  • lychee.toml - Configuration file with settings moved from workflow args, including the performance comment from the original workflow
  • .github/scripts/check-links.sh - Docker-based script for local lychee execution
  • .github/scripts/dependencies.dockerfile - Enables Renovate auto-updates for lychee Docker image
  • .github/workflows/reusable-check-links.yml - New workflow that uses the script instead of lychee-action

Modified Files

  • .github/workflows/build.yml - Updated to reference the new reusable-check-links.yml workflow

Removed Files

  • .github/workflows/reusable-markdown-link-check.yml - Replaced by the new script-based approach

Benefits

Local execution: Users can now run GITHUB_TOKEN=xxx ./.github/scripts/check-links.sh locally
Same configuration: Uses identical settings as CI via shared lychee.toml
Auto-updates: Renovate will keep the lychee Docker image version current
Cross-platform: Works on Windows, macOS, and Linux with Docker

Configuration Moved

The following arguments were moved from the workflow to lychee.toml:

  • --include-fragmentsinclude_fragments = true
  • --exclude "^https://github.com/open-telemetry/opentelemetry-java-contrib/(issues|pull)/\\d+$"exclude array
  • --max-retries 6max_retries = 6
  • --max-concurrency 1max_concurrency = 1

The performance-related comment was preserved in the config file as requested.

Fixes #11.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI changed the title [WIP] Make it easier to run lychee locally Make it easier to run lychee locally Jun 29, 2025
Copilot AI requested a review from trask June 29, 2025 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make it easier to run lychee locally

3 participants